AccountAndTransactionAPI

AccountAccess

createAccountAccessConsents

Create Account Access Consents


/account-access-consents

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/account-access-consents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountAccessApi;

import java.io.File;
import java.util.*;

public class AccountAccessApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        AccountAccessApi apiInstance = new AccountAccessApi();
        OBReadConsent1 body = ; // OBReadConsent1 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadConsentResponse1 result = apiInstance.createAccountAccessConsents(body, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAccessApi#createAccountAccessConsents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountAccessApi;

public class AccountAccessApiExample {

    public static void main(String[] args) {
        AccountAccessApi apiInstance = new AccountAccessApi();
        OBReadConsent1 body = ; // OBReadConsent1 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadConsentResponse1 result = apiInstance.createAccountAccessConsents(body, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAccessApi#createAccountAccessConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBReadConsent1 *body = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

AccountAccessApi *apiInstance = [[AccountAccessApi alloc] init];

// Create Account Access Consents
[apiInstance createAccountAccessConsentsWith:body
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadConsentResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.AccountAccessApi()
var body = ; // {{OBReadConsent1}} Default
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAccountAccessConsents(bodyauthorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createAccountAccessConsentsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AccountAccessApi();
            var body = new OBReadConsent1(); // OBReadConsent1 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Create Account Access Consents
                OBReadConsentResponse1 result = apiInstance.createAccountAccessConsents(body, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountAccessApi.createAccountAccessConsents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAccountAccessApi();
$body = ; // OBReadConsent1 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->createAccountAccessConsents($body, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountAccessApi->createAccountAccessConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountAccessApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AccountAccessApi->new();
my $body = WWW::SwaggerClient::Object::OBReadConsent1->new(); # OBReadConsent1 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->createAccountAccessConsents(body => $body, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountAccessApi->createAccountAccessConsents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountAccessApi()
body =  # OBReadConsent1 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Create Account Access Consents
    api_response = api_instance.create_account_access_consents(body, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountAccessApi->createAccountAccessConsents: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
body *

Responses

Status: 201 - Account Access Consents Created

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

deleteAccountAccessConsentsConsentId

Delete Account Access Consents


/account-access-consents/{ConsentId}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/account-access-consents/{ConsentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountAccessApi;

import java.io.File;
import java.util.*;

public class AccountAccessApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        AccountAccessApi apiInstance = new AccountAccessApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            apiInstance.deleteAccountAccessConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAccessApi#deleteAccountAccessConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountAccessApi;

public class AccountAccessApiExample {

    public static void main(String[] args) {
        AccountAccessApi apiInstance = new AccountAccessApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            apiInstance.deleteAccountAccessConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAccessApi#deleteAccountAccessConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

AccountAccessApi *apiInstance = [[AccountAccessApi alloc] init];

// Delete Account Access Consents
[apiInstance deleteAccountAccessConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.AccountAccessApi()
var consentId = consentId_example; // {{String}} ConsentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAccountAccessConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAccountAccessConsentsConsentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AccountAccessApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Delete Account Access Consents
                apiInstance.deleteAccountAccessConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountAccessApi.deleteAccountAccessConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAccountAccessApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $api_instance->deleteAccountAccessConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
} catch (Exception $e) {
    echo 'Exception when calling AccountAccessApi->deleteAccountAccessConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountAccessApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AccountAccessApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    $api_instance->deleteAccountAccessConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
};
if ($@) {
    warn "Exception when calling AccountAccessApi->deleteAccountAccessConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountAccessApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Delete Account Access Consents
    api_instance.delete_account_access_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
except ApiException as e:
    print("Exception when calling AccountAccessApi->deleteAccountAccessConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 204 - Account Access Consents Deleted

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

getAccountAccessConsentsConsentId

Get Account Access Consents


/account-access-consents/{ConsentId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/account-access-consents/{ConsentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountAccessApi;

import java.io.File;
import java.util.*;

public class AccountAccessApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        AccountAccessApi apiInstance = new AccountAccessApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadConsentResponse1 result = apiInstance.getAccountAccessConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAccessApi#getAccountAccessConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountAccessApi;

public class AccountAccessApiExample {

    public static void main(String[] args) {
        AccountAccessApi apiInstance = new AccountAccessApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadConsentResponse1 result = apiInstance.getAccountAccessConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAccessApi#getAccountAccessConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

AccountAccessApi *apiInstance = [[AccountAccessApi alloc] init];

// Get Account Access Consents
[apiInstance getAccountAccessConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadConsentResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.AccountAccessApi()
var consentId = consentId_example; // {{String}} ConsentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountAccessConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountAccessConsentsConsentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AccountAccessApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Account Access Consents
                OBReadConsentResponse1 result = apiInstance.getAccountAccessConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountAccessApi.getAccountAccessConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAccountAccessApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getAccountAccessConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountAccessApi->getAccountAccessConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountAccessApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AccountAccessApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getAccountAccessConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountAccessApi->getAccountAccessConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountAccessApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Account Access Consents
    api_response = api_instance.get_account_access_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountAccessApi->getAccountAccessConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Account Access Consents Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

Accounts

getAccounts

Get Accounts


/accounts

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/accounts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountsApi;

import java.io.File;
import java.util.*;

public class AccountsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        AccountsApi apiInstance = new AccountsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadAccount6 result = apiInstance.getAccounts(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getAccounts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountsApi;

public class AccountsApiExample {

    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadAccount6 result = apiInstance.getAccounts(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getAccounts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

AccountsApi *apiInstance = [[AccountsApi alloc] init];

// Get Accounts
[apiInstance getAccountsWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadAccount6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.AccountsApi()
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccounts(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AccountsApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Accounts
                OBReadAccount6 result = apiInstance.getAccounts(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.getAccounts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAccountsApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getAccounts($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->getAccounts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getAccounts(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountsApi->getAccounts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountsApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Accounts
    api_response = api_instance.get_accounts(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->getAccounts: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Accounts Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

getAccountsAccountId

Get Accounts


/accounts/{AccountId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/accounts/{AccountId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountsApi;

import java.io.File;
import java.util.*;

public class AccountsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        AccountsApi apiInstance = new AccountsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadAccount6 result = apiInstance.getAccountsAccountId(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getAccountsAccountId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountsApi;

public class AccountsApiExample {

    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadAccount6 result = apiInstance.getAccountsAccountId(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getAccountsAccountId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

AccountsApi *apiInstance = [[AccountsApi alloc] init];

// Get Accounts
[apiInstance getAccountsAccountIdWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadAccount6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.AccountsApi()
var accountId = accountId_example; // {{String}} AccountId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountId(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AccountsApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Accounts
                OBReadAccount6 result = apiInstance.getAccountsAccountId(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.getAccountsAccountId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAccountsApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getAccountsAccountId($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->getAccountsAccountId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getAccountsAccountId(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountsApi->getAccountsAccountId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountsApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Accounts
    api_response = api_instance.get_accounts_account_id(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->getAccountsAccountId: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Accounts Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

Balances

getAccountsAccountIdBalances

Get Balances


/accounts/{AccountId}/balances

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/accounts/{AccountId}/balances"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BalancesApi;

import java.io.File;
import java.util.*;

public class BalancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        BalancesApi apiInstance = new BalancesApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadBalance1 result = apiInstance.getAccountsAccountIdBalances(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BalancesApi#getAccountsAccountIdBalances");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BalancesApi;

public class BalancesApiExample {

    public static void main(String[] args) {
        BalancesApi apiInstance = new BalancesApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadBalance1 result = apiInstance.getAccountsAccountIdBalances(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BalancesApi#getAccountsAccountIdBalances");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

BalancesApi *apiInstance = [[BalancesApi alloc] init];

// Get Balances
[apiInstance getAccountsAccountIdBalancesWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadBalance1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.BalancesApi()
var accountId = accountId_example; // {{String}} AccountId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdBalances(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdBalancesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BalancesApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Balances
                OBReadBalance1 result = apiInstance.getAccountsAccountIdBalances(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BalancesApi.getAccountsAccountIdBalances: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBalancesApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getAccountsAccountIdBalances($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BalancesApi->getAccountsAccountIdBalances: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BalancesApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BalancesApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getAccountsAccountIdBalances(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BalancesApi->getAccountsAccountIdBalances: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BalancesApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Balances
    api_response = api_instance.get_accounts_account_id_balances(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalancesApi->getAccountsAccountIdBalances: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Balances Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

getBalances

Get Balances


/balances

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/balances"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BalancesApi;

import java.io.File;
import java.util.*;

public class BalancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        BalancesApi apiInstance = new BalancesApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadBalance1 result = apiInstance.getBalances(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BalancesApi#getBalances");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BalancesApi;

public class BalancesApiExample {

    public static void main(String[] args) {
        BalancesApi apiInstance = new BalancesApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadBalance1 result = apiInstance.getBalances(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BalancesApi#getBalances");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

BalancesApi *apiInstance = [[BalancesApi alloc] init];

// Get Balances
[apiInstance getBalancesWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadBalance1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.BalancesApi()
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBalances(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBalancesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BalancesApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Balances
                OBReadBalance1 result = apiInstance.getBalances(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BalancesApi.getBalances: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBalancesApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getBalances($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BalancesApi->getBalances: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BalancesApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BalancesApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getBalances(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BalancesApi->getBalances: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BalancesApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Balances
    api_response = api_instance.get_balances(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalancesApi->getBalances: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Balances Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

Beneficiaries

getAccountsAccountIdBeneficiaries

Get Beneficiaries


/accounts/{AccountId}/beneficiaries

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/accounts/{AccountId}/beneficiaries"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BeneficiariesApi;

import java.io.File;
import java.util.*;

public class BeneficiariesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        BeneficiariesApi apiInstance = new BeneficiariesApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadBeneficiary5 result = apiInstance.getAccountsAccountIdBeneficiaries(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BeneficiariesApi#getAccountsAccountIdBeneficiaries");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BeneficiariesApi;

public class BeneficiariesApiExample {

    public static void main(String[] args) {
        BeneficiariesApi apiInstance = new BeneficiariesApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadBeneficiary5 result = apiInstance.getAccountsAccountIdBeneficiaries(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BeneficiariesApi#getAccountsAccountIdBeneficiaries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

BeneficiariesApi *apiInstance = [[BeneficiariesApi alloc] init];

// Get Beneficiaries
[apiInstance getAccountsAccountIdBeneficiariesWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadBeneficiary5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.BeneficiariesApi()
var accountId = accountId_example; // {{String}} AccountId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdBeneficiaries(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdBeneficiariesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BeneficiariesApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Beneficiaries
                OBReadBeneficiary5 result = apiInstance.getAccountsAccountIdBeneficiaries(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BeneficiariesApi.getAccountsAccountIdBeneficiaries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBeneficiariesApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getAccountsAccountIdBeneficiaries($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BeneficiariesApi->getAccountsAccountIdBeneficiaries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BeneficiariesApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BeneficiariesApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getAccountsAccountIdBeneficiaries(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BeneficiariesApi->getAccountsAccountIdBeneficiaries: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BeneficiariesApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Beneficiaries
    api_response = api_instance.get_accounts_account_id_beneficiaries(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BeneficiariesApi->getAccountsAccountIdBeneficiaries: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Beneficiaries Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

getBeneficiaries

Get Beneficiaries


/beneficiaries

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/beneficiaries"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BeneficiariesApi;

import java.io.File;
import java.util.*;

public class BeneficiariesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        BeneficiariesApi apiInstance = new BeneficiariesApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadBeneficiary5 result = apiInstance.getBeneficiaries(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BeneficiariesApi#getBeneficiaries");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BeneficiariesApi;

public class BeneficiariesApiExample {

    public static void main(String[] args) {
        BeneficiariesApi apiInstance = new BeneficiariesApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadBeneficiary5 result = apiInstance.getBeneficiaries(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BeneficiariesApi#getBeneficiaries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

BeneficiariesApi *apiInstance = [[BeneficiariesApi alloc] init];

// Get Beneficiaries
[apiInstance getBeneficiariesWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadBeneficiary5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.BeneficiariesApi()
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBeneficiaries(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBeneficiariesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BeneficiariesApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Beneficiaries
                OBReadBeneficiary5 result = apiInstance.getBeneficiaries(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BeneficiariesApi.getBeneficiaries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBeneficiariesApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getBeneficiaries($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BeneficiariesApi->getBeneficiaries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BeneficiariesApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BeneficiariesApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getBeneficiaries(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BeneficiariesApi->getBeneficiaries: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BeneficiariesApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Beneficiaries
    api_response = api_instance.get_beneficiaries(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BeneficiariesApi->getBeneficiaries: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Beneficiaries Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

DirectDebits

getAccountsAccountIdDirectDebits

Get Direct Debits


/accounts/{AccountId}/direct-debits

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/accounts/{AccountId}/direct-debits"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DirectDebitsApi;

import java.io.File;
import java.util.*;

public class DirectDebitsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DirectDebitsApi apiInstance = new DirectDebitsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadDirectDebit2 result = apiInstance.getAccountsAccountIdDirectDebits(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DirectDebitsApi#getAccountsAccountIdDirectDebits");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DirectDebitsApi;

public class DirectDebitsApiExample {

    public static void main(String[] args) {
        DirectDebitsApi apiInstance = new DirectDebitsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadDirectDebit2 result = apiInstance.getAccountsAccountIdDirectDebits(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DirectDebitsApi#getAccountsAccountIdDirectDebits");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

DirectDebitsApi *apiInstance = [[DirectDebitsApi alloc] init];

// Get Direct Debits
[apiInstance getAccountsAccountIdDirectDebitsWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadDirectDebit2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.DirectDebitsApi()
var accountId = accountId_example; // {{String}} AccountId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdDirectDebits(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdDirectDebitsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DirectDebitsApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Direct Debits
                OBReadDirectDebit2 result = apiInstance.getAccountsAccountIdDirectDebits(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DirectDebitsApi.getAccountsAccountIdDirectDebits: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDirectDebitsApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getAccountsAccountIdDirectDebits($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectDebitsApi->getAccountsAccountIdDirectDebits: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DirectDebitsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DirectDebitsApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getAccountsAccountIdDirectDebits(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DirectDebitsApi->getAccountsAccountIdDirectDebits: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DirectDebitsApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Direct Debits
    api_response = api_instance.get_accounts_account_id_direct_debits(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DirectDebitsApi->getAccountsAccountIdDirectDebits: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Direct Debits Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

getDirectDebits

Get Direct Debits


/direct-debits

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/direct-debits"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DirectDebitsApi;

import java.io.File;
import java.util.*;

public class DirectDebitsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DirectDebitsApi apiInstance = new DirectDebitsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadDirectDebit2 result = apiInstance.getDirectDebits(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DirectDebitsApi#getDirectDebits");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DirectDebitsApi;

public class DirectDebitsApiExample {

    public static void main(String[] args) {
        DirectDebitsApi apiInstance = new DirectDebitsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadDirectDebit2 result = apiInstance.getDirectDebits(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DirectDebitsApi#getDirectDebits");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

DirectDebitsApi *apiInstance = [[DirectDebitsApi alloc] init];

// Get Direct Debits
[apiInstance getDirectDebitsWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadDirectDebit2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.DirectDebitsApi()
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDirectDebits(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDirectDebitsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DirectDebitsApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Direct Debits
                OBReadDirectDebit2 result = apiInstance.getDirectDebits(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DirectDebitsApi.getDirectDebits: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDirectDebitsApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getDirectDebits($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectDebitsApi->getDirectDebits: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DirectDebitsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DirectDebitsApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getDirectDebits(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DirectDebitsApi->getDirectDebits: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DirectDebitsApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Direct Debits
    api_response = api_instance.get_direct_debits(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DirectDebitsApi->getDirectDebits: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Direct Debits Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

Offers

getAccountsAccountIdOffers

Get Offers


/accounts/{AccountId}/offers

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/accounts/{AccountId}/offers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OffersApi;

import java.io.File;
import java.util.*;

public class OffersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        OffersApi apiInstance = new OffersApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadOffer1 result = apiInstance.getAccountsAccountIdOffers(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#getAccountsAccountIdOffers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OffersApi;

public class OffersApiExample {

    public static void main(String[] args) {
        OffersApi apiInstance = new OffersApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadOffer1 result = apiInstance.getAccountsAccountIdOffers(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#getAccountsAccountIdOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

OffersApi *apiInstance = [[OffersApi alloc] init];

// Get Offers
[apiInstance getAccountsAccountIdOffersWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadOffer1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.OffersApi()
var accountId = accountId_example; // {{String}} AccountId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdOffers(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdOffersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OffersApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Offers
                OBReadOffer1 result = apiInstance.getAccountsAccountIdOffers(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OffersApi.getAccountsAccountIdOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiOffersApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getAccountsAccountIdOffers($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OffersApi->getAccountsAccountIdOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OffersApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OffersApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getAccountsAccountIdOffers(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OffersApi->getAccountsAccountIdOffers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OffersApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Offers
    api_response = api_instance.get_accounts_account_id_offers(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OffersApi->getAccountsAccountIdOffers: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Offers Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

getOffers

Get Offers


/offers

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/offers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OffersApi;

import java.io.File;
import java.util.*;

public class OffersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        OffersApi apiInstance = new OffersApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadOffer1 result = apiInstance.getOffers(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#getOffers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OffersApi;

public class OffersApiExample {

    public static void main(String[] args) {
        OffersApi apiInstance = new OffersApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadOffer1 result = apiInstance.getOffers(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#getOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

OffersApi *apiInstance = [[OffersApi alloc] init];

// Get Offers
[apiInstance getOffersWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadOffer1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.OffersApi()
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOffers(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOffersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OffersApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Offers
                OBReadOffer1 result = apiInstance.getOffers(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OffersApi.getOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiOffersApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getOffers($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OffersApi->getOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OffersApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OffersApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getOffers(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OffersApi->getOffers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OffersApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Offers
    api_response = api_instance.get_offers(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OffersApi->getOffers: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Offers Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

Parties

getAccountsAccountIdParties

Get Parties


/accounts/{AccountId}/parties

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/accounts/{AccountId}/parties"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PartiesApi;

import java.io.File;
import java.util.*;

public class PartiesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        PartiesApi apiInstance = new PartiesApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadParty3 result = apiInstance.getAccountsAccountIdParties(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartiesApi#getAccountsAccountIdParties");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PartiesApi;

public class PartiesApiExample {

    public static void main(String[] args) {
        PartiesApi apiInstance = new PartiesApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadParty3 result = apiInstance.getAccountsAccountIdParties(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartiesApi#getAccountsAccountIdParties");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

PartiesApi *apiInstance = [[PartiesApi alloc] init];

// Get Parties
[apiInstance getAccountsAccountIdPartiesWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadParty3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.PartiesApi()
var accountId = accountId_example; // {{String}} AccountId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdParties(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdPartiesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PartiesApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Parties
                OBReadParty3 result = apiInstance.getAccountsAccountIdParties(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PartiesApi.getAccountsAccountIdParties: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPartiesApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getAccountsAccountIdParties($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PartiesApi->getAccountsAccountIdParties: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PartiesApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PartiesApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getAccountsAccountIdParties(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PartiesApi->getAccountsAccountIdParties: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PartiesApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Parties
    api_response = api_instance.get_accounts_account_id_parties(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PartiesApi->getAccountsAccountIdParties: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Parties Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

getAccountsAccountIdParty

Get Parties


/accounts/{AccountId}/party

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/accounts/{AccountId}/party"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PartiesApi;

import java.io.File;
import java.util.*;

public class PartiesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        PartiesApi apiInstance = new PartiesApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadParty2 result = apiInstance.getAccountsAccountIdParty(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartiesApi#getAccountsAccountIdParty");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PartiesApi;

public class PartiesApiExample {

    public static void main(String[] args) {
        PartiesApi apiInstance = new PartiesApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadParty2 result = apiInstance.getAccountsAccountIdParty(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartiesApi#getAccountsAccountIdParty");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

PartiesApi *apiInstance = [[PartiesApi alloc] init];

// Get Parties
[apiInstance getAccountsAccountIdPartyWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadParty2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.PartiesApi()
var accountId = accountId_example; // {{String}} AccountId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdParty(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdPartyExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PartiesApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Parties
                OBReadParty2 result = apiInstance.getAccountsAccountIdParty(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PartiesApi.getAccountsAccountIdParty: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPartiesApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getAccountsAccountIdParty($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PartiesApi->getAccountsAccountIdParty: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PartiesApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PartiesApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getAccountsAccountIdParty(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PartiesApi->getAccountsAccountIdParty: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PartiesApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Parties
    api_response = api_instance.get_accounts_account_id_party(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PartiesApi->getAccountsAccountIdParty: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Parties Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

getParty

Get Parties


/party

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/party"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PartiesApi;

import java.io.File;
import java.util.*;

public class PartiesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        PartiesApi apiInstance = new PartiesApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadParty2 result = apiInstance.getParty(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartiesApi#getParty");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PartiesApi;

public class PartiesApiExample {

    public static void main(String[] args) {
        PartiesApi apiInstance = new PartiesApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadParty2 result = apiInstance.getParty(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartiesApi#getParty");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

PartiesApi *apiInstance = [[PartiesApi alloc] init];

// Get Parties
[apiInstance getPartyWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadParty2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.PartiesApi()
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getParty(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPartyExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PartiesApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Parties
                OBReadParty2 result = apiInstance.getParty(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PartiesApi.getParty: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPartiesApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getParty($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PartiesApi->getParty: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PartiesApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PartiesApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getParty(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PartiesApi->getParty: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PartiesApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Parties
    api_response = api_instance.get_party(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PartiesApi->getParty: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Parties Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

Products

getAccountsAccountIdProduct

Get Products


/accounts/{AccountId}/product

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/accounts/{AccountId}/product"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

import java.io.File;
import java.util.*;

public class ProductsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadProduct2 result = apiInstance.getAccountsAccountIdProduct(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getAccountsAccountIdProduct");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadProduct2 result = apiInstance.getAccountsAccountIdProduct(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getAccountsAccountIdProduct");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

ProductsApi *apiInstance = [[ProductsApi alloc] init];

// Get Products
[apiInstance getAccountsAccountIdProductWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadProduct2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.ProductsApi()
var accountId = accountId_example; // {{String}} AccountId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdProduct(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdProductExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Products
                OBReadProduct2 result = apiInstance.getAccountsAccountIdProduct(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.getAccountsAccountIdProduct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getAccountsAccountIdProduct($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getAccountsAccountIdProduct: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getAccountsAccountIdProduct(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->getAccountsAccountIdProduct: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Products
    api_response = api_instance.get_accounts_account_id_product(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->getAccountsAccountIdProduct: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Products Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

getProducts

Get Products


/products

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/products"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

import java.io.File;
import java.util.*;

public class ProductsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadProduct2 result = apiInstance.getProducts(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProducts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadProduct2 result = apiInstance.getProducts(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProducts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

ProductsApi *apiInstance = [[ProductsApi alloc] init];

// Get Products
[apiInstance getProductsWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadProduct2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.ProductsApi()
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProducts(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProductsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Products
                OBReadProduct2 result = apiInstance.getProducts(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.getProducts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getProducts($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getProducts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getProducts(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->getProducts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Products
    api_response = api_instance.get_products(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->getProducts: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Products Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

ScheduledPayments

getAccountsAccountIdScheduledPayments

Get Scheduled Payments


/accounts/{AccountId}/scheduled-payments

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/accounts/{AccountId}/scheduled-payments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class ScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        ScheduledPaymentsApi apiInstance = new ScheduledPaymentsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadScheduledPayment3 result = apiInstance.getAccountsAccountIdScheduledPayments(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduledPaymentsApi#getAccountsAccountIdScheduledPayments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScheduledPaymentsApi;

public class ScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ScheduledPaymentsApi apiInstance = new ScheduledPaymentsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadScheduledPayment3 result = apiInstance.getAccountsAccountIdScheduledPayments(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduledPaymentsApi#getAccountsAccountIdScheduledPayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

ScheduledPaymentsApi *apiInstance = [[ScheduledPaymentsApi alloc] init];

// Get Scheduled Payments
[apiInstance getAccountsAccountIdScheduledPaymentsWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadScheduledPayment3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.ScheduledPaymentsApi()
var accountId = accountId_example; // {{String}} AccountId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdScheduledPayments(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdScheduledPaymentsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScheduledPaymentsApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Scheduled Payments
                OBReadScheduledPayment3 result = apiInstance.getAccountsAccountIdScheduledPayments(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScheduledPaymentsApi.getAccountsAccountIdScheduledPayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScheduledPaymentsApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getAccountsAccountIdScheduledPayments($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScheduledPaymentsApi->getAccountsAccountIdScheduledPayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScheduledPaymentsApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getAccountsAccountIdScheduledPayments(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScheduledPaymentsApi->getAccountsAccountIdScheduledPayments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScheduledPaymentsApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Scheduled Payments
    api_response = api_instance.get_accounts_account_id_scheduled_payments(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScheduledPaymentsApi->getAccountsAccountIdScheduledPayments: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Scheduled Payments Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

getScheduledPayments

Get Scheduled Payments


/scheduled-payments

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/scheduled-payments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class ScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        ScheduledPaymentsApi apiInstance = new ScheduledPaymentsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadScheduledPayment3 result = apiInstance.getScheduledPayments(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduledPaymentsApi#getScheduledPayments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScheduledPaymentsApi;

public class ScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ScheduledPaymentsApi apiInstance = new ScheduledPaymentsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadScheduledPayment3 result = apiInstance.getScheduledPayments(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduledPaymentsApi#getScheduledPayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

ScheduledPaymentsApi *apiInstance = [[ScheduledPaymentsApi alloc] init];

// Get Scheduled Payments
[apiInstance getScheduledPaymentsWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadScheduledPayment3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.ScheduledPaymentsApi()
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getScheduledPayments(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getScheduledPaymentsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScheduledPaymentsApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Scheduled Payments
                OBReadScheduledPayment3 result = apiInstance.getScheduledPayments(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScheduledPaymentsApi.getScheduledPayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScheduledPaymentsApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getScheduledPayments($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScheduledPaymentsApi->getScheduledPayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScheduledPaymentsApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getScheduledPayments(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScheduledPaymentsApi->getScheduledPayments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScheduledPaymentsApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Scheduled Payments
    api_response = api_instance.get_scheduled_payments(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScheduledPaymentsApi->getScheduledPayments: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Scheduled Payments Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

StandingOrders

getAccountsAccountIdStandingOrders

Get Standing Orders


/accounts/{AccountId}/standing-orders

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/accounts/{AccountId}/standing-orders"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StandingOrdersApi;

import java.io.File;
import java.util.*;

public class StandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        StandingOrdersApi apiInstance = new StandingOrdersApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadStandingOrder6 result = apiInstance.getAccountsAccountIdStandingOrders(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StandingOrdersApi#getAccountsAccountIdStandingOrders");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StandingOrdersApi;

public class StandingOrdersApiExample {

    public static void main(String[] args) {
        StandingOrdersApi apiInstance = new StandingOrdersApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadStandingOrder6 result = apiInstance.getAccountsAccountIdStandingOrders(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StandingOrdersApi#getAccountsAccountIdStandingOrders");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

StandingOrdersApi *apiInstance = [[StandingOrdersApi alloc] init];

// Get Standing Orders
[apiInstance getAccountsAccountIdStandingOrdersWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadStandingOrder6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.StandingOrdersApi()
var accountId = accountId_example; // {{String}} AccountId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdStandingOrders(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdStandingOrdersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StandingOrdersApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Standing Orders
                OBReadStandingOrder6 result = apiInstance.getAccountsAccountIdStandingOrders(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StandingOrdersApi.getAccountsAccountIdStandingOrders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiStandingOrdersApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getAccountsAccountIdStandingOrders($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StandingOrdersApi->getAccountsAccountIdStandingOrders: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StandingOrdersApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::StandingOrdersApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getAccountsAccountIdStandingOrders(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StandingOrdersApi->getAccountsAccountIdStandingOrders: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.StandingOrdersApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Standing Orders
    api_response = api_instance.get_accounts_account_id_standing_orders(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StandingOrdersApi->getAccountsAccountIdStandingOrders: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Standing Orders Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

getStandingOrders

Get Standing Orders


/standing-orders

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/standing-orders"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StandingOrdersApi;

import java.io.File;
import java.util.*;

public class StandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        StandingOrdersApi apiInstance = new StandingOrdersApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadStandingOrder6 result = apiInstance.getStandingOrders(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StandingOrdersApi#getStandingOrders");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StandingOrdersApi;

public class StandingOrdersApiExample {

    public static void main(String[] args) {
        StandingOrdersApi apiInstance = new StandingOrdersApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadStandingOrder6 result = apiInstance.getStandingOrders(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StandingOrdersApi#getStandingOrders");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

StandingOrdersApi *apiInstance = [[StandingOrdersApi alloc] init];

// Get Standing Orders
[apiInstance getStandingOrdersWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadStandingOrder6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.StandingOrdersApi()
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStandingOrders(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getStandingOrdersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StandingOrdersApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Standing Orders
                OBReadStandingOrder6 result = apiInstance.getStandingOrders(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StandingOrdersApi.getStandingOrders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiStandingOrdersApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getStandingOrders($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StandingOrdersApi->getStandingOrders: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StandingOrdersApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::StandingOrdersApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getStandingOrders(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StandingOrdersApi->getStandingOrders: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.StandingOrdersApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Standing Orders
    api_response = api_instance.get_standing_orders(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StandingOrdersApi->getStandingOrders: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Standing Orders Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

Statements

getAccountsAccountIdStatements

Get Statements


/accounts/{AccountId}/statements

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/accounts/{AccountId}/statements?fromStatementDateTime=&toStatementDateTime="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StatementsApi;

import java.io.File;
import java.util.*;

public class StatementsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        StatementsApi apiInstance = new StatementsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        Date fromStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        Date toStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        try {
            OBReadStatement2 result = apiInstance.getAccountsAccountIdStatements(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent, fromStatementDateTime, toStatementDateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#getAccountsAccountIdStatements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StatementsApi;

public class StatementsApiExample {

    public static void main(String[] args) {
        StatementsApi apiInstance = new StatementsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        Date fromStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        Date toStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        try {
            OBReadStatement2 result = apiInstance.getAccountsAccountIdStatements(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent, fromStatementDateTime, toStatementDateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#getAccountsAccountIdStatements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)
Date *fromStatementDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
Date *toStatementDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)

StatementsApi *apiInstance = [[StatementsApi alloc] init];

// Get Statements
[apiInstance getAccountsAccountIdStatementsWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
    fromStatementDateTime:fromStatementDateTime
    toStatementDateTime:toStatementDateTime
              completionHandler: ^(OBReadStatement2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.StatementsApi()
var accountId = accountId_example; // {{String}} AccountId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example, // {{String}} Indicates the user-agent that the PSU is using.
  'fromStatementDateTime': 2013-10-20T19:20:30+01:00, // {{Date}} The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
  'toStatementDateTime': 2013-10-20T19:20:30+01:00 // {{Date}} The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdStatements(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdStatementsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StatementsApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 
            var fromStatementDateTime = 2013-10-20T19:20:30+01:00;  // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional) 
            var toStatementDateTime = 2013-10-20T19:20:30+01:00;  // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional) 

            try
            {
                // Get Statements
                OBReadStatement2 result = apiInstance.getAccountsAccountIdStatements(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent, fromStatementDateTime, toStatementDateTime);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatementsApi.getAccountsAccountIdStatements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiStatementsApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
$fromStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
$toStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

try {
    $result = $api_instance->getAccountsAccountIdStatements($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent, $fromStatementDateTime, $toStatementDateTime);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StatementsApi->getAccountsAccountIdStatements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StatementsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::StatementsApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.
my $fromStatementDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
my $toStatementDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

eval { 
    my $result = $api_instance->getAccountsAccountIdStatements(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent, fromStatementDateTime => $fromStatementDateTime, toStatementDateTime => $toStatementDateTime);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatementsApi->getAccountsAccountIdStatements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.StatementsApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)
fromStatementDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
toStatementDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)

try: 
    # Get Statements
    api_response = api_instance.get_accounts_account_id_statements(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent, fromStatementDateTime=fromStatementDateTime, toStatementDateTime=toStatementDateTime)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatementsApi->getAccountsAccountIdStatements: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Query parameters
Name Description
fromStatementDateTime
Date (date-time)
The UTC ISO 8601 Date Time to filter statements FROM NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
toStatementDateTime
Date (date-time)
The UTC ISO 8601 Date Time to filter statements TO NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

Responses

Status: 200 - Statements Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

getAccountsAccountIdStatementsStatementId

Get Statements


/accounts/{AccountId}/statements/{StatementId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/accounts/{AccountId}/statements/{StatementId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StatementsApi;

import java.io.File;
import java.util.*;

public class StatementsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        StatementsApi apiInstance = new StatementsApi();
        String statementId = statementId_example; // String | StatementId
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadStatement2 result = apiInstance.getAccountsAccountIdStatementsStatementId(statementId, accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#getAccountsAccountIdStatementsStatementId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StatementsApi;

public class StatementsApiExample {

    public static void main(String[] args) {
        StatementsApi apiInstance = new StatementsApi();
        String statementId = statementId_example; // String | StatementId
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadStatement2 result = apiInstance.getAccountsAccountIdStatementsStatementId(statementId, accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#getAccountsAccountIdStatementsStatementId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *statementId = statementId_example; // StatementId
String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

StatementsApi *apiInstance = [[StatementsApi alloc] init];

// Get Statements
[apiInstance getAccountsAccountIdStatementsStatementIdWith:statementId
    accountId:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadStatement2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.StatementsApi()
var statementId = statementId_example; // {{String}} StatementId
var accountId = accountId_example; // {{String}} AccountId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdStatementsStatementId(statementId, accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdStatementsStatementIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StatementsApi();
            var statementId = statementId_example;  // String | StatementId
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Statements
                OBReadStatement2 result = apiInstance.getAccountsAccountIdStatementsStatementId(statementId, accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatementsApi.getAccountsAccountIdStatementsStatementId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiStatementsApi();
$statementId = statementId_example; // String | StatementId
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getAccountsAccountIdStatementsStatementId($statementId, $accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StatementsApi->getAccountsAccountIdStatementsStatementId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StatementsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::StatementsApi->new();
my $statementId = statementId_example; # String | StatementId
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getAccountsAccountIdStatementsStatementId(statementId => $statementId, accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatementsApi->getAccountsAccountIdStatementsStatementId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.StatementsApi()
statementId = statementId_example # String | StatementId
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Statements
    api_response = api_instance.get_accounts_account_id_statements_statement_id(statementId, accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatementsApi->getAccountsAccountIdStatementsStatementId: %s\n" % e)

Parameters

Path parameters
Name Description
StatementId*
String
StatementId
Required
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Statements Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

getAccountsAccountIdStatementsStatementIdFile

Get Statements


/accounts/{AccountId}/statements/{StatementId}/file

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/accounts/{AccountId}/statements/{StatementId}/file"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StatementsApi;

import java.io.File;
import java.util.*;

public class StatementsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        StatementsApi apiInstance = new StatementsApi();
        String statementId = statementId_example; // String | StatementId
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            File result = apiInstance.getAccountsAccountIdStatementsStatementIdFile(statementId, accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#getAccountsAccountIdStatementsStatementIdFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StatementsApi;

public class StatementsApiExample {

    public static void main(String[] args) {
        StatementsApi apiInstance = new StatementsApi();
        String statementId = statementId_example; // String | StatementId
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            File result = apiInstance.getAccountsAccountIdStatementsStatementIdFile(statementId, accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#getAccountsAccountIdStatementsStatementIdFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *statementId = statementId_example; // StatementId
String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

StatementsApi *apiInstance = [[StatementsApi alloc] init];

// Get Statements
[apiInstance getAccountsAccountIdStatementsStatementIdFileWith:statementId
    accountId:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(File output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.StatementsApi()
var statementId = statementId_example; // {{String}} StatementId
var accountId = accountId_example; // {{String}} AccountId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdStatementsStatementIdFile(statementId, accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdStatementsStatementIdFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StatementsApi();
            var statementId = statementId_example;  // String | StatementId
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Statements
                File result = apiInstance.getAccountsAccountIdStatementsStatementIdFile(statementId, accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatementsApi.getAccountsAccountIdStatementsStatementIdFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiStatementsApi();
$statementId = statementId_example; // String | StatementId
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getAccountsAccountIdStatementsStatementIdFile($statementId, $accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StatementsApi->getAccountsAccountIdStatementsStatementIdFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StatementsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::StatementsApi->new();
my $statementId = statementId_example; # String | StatementId
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getAccountsAccountIdStatementsStatementIdFile(statementId => $statementId, accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatementsApi->getAccountsAccountIdStatementsStatementIdFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.StatementsApi()
statementId = statementId_example # String | StatementId
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Statements
    api_response = api_instance.get_accounts_account_id_statements_statement_id_file(statementId, accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatementsApi->getAccountsAccountIdStatementsStatementIdFile: %s\n" % e)

Parameters

Path parameters
Name Description
StatementId*
String
StatementId
Required
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Statements Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

getStatements

Get Statements


/statements

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/statements?fromStatementDateTime=&toStatementDateTime="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StatementsApi;

import java.io.File;
import java.util.*;

public class StatementsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        StatementsApi apiInstance = new StatementsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        Date fromStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        Date toStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadStatement2 result = apiInstance.getStatements(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, fromStatementDateTime, toStatementDateTime, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#getStatements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StatementsApi;

public class StatementsApiExample {

    public static void main(String[] args) {
        StatementsApi apiInstance = new StatementsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        Date fromStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        Date toStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadStatement2 result = apiInstance.getStatements(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, fromStatementDateTime, toStatementDateTime, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#getStatements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
Date *fromStatementDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
Date *toStatementDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

StatementsApi *apiInstance = [[StatementsApi alloc] init];

// Get Statements
[apiInstance getStatementsWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    fromStatementDateTime:fromStatementDateTime
    toStatementDateTime:toStatementDateTime
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadStatement2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.StatementsApi()
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'fromStatementDateTime': 2013-10-20T19:20:30+01:00, // {{Date}} The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
  'toStatementDateTime': 2013-10-20T19:20:30+01:00, // {{Date}} The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStatements(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getStatementsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StatementsApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var fromStatementDateTime = 2013-10-20T19:20:30+01:00;  // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional) 
            var toStatementDateTime = 2013-10-20T19:20:30+01:00;  // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Statements
                OBReadStatement2 result = apiInstance.getStatements(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, fromStatementDateTime, toStatementDateTime, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatementsApi.getStatements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiStatementsApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$fromStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
$toStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getStatements($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $fromStatementDateTime, $toStatementDateTime, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StatementsApi->getStatements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StatementsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::StatementsApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $fromStatementDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
my $toStatementDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getStatements(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, fromStatementDateTime => $fromStatementDateTime, toStatementDateTime => $toStatementDateTime, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatementsApi->getStatements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.StatementsApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
fromStatementDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
toStatementDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Statements
    api_response = api_instance.get_statements(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, fromStatementDateTime=fromStatementDateTime, toStatementDateTime=toStatementDateTime, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatementsApi->getStatements: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Query parameters
Name Description
fromStatementDateTime
Date (date-time)
The UTC ISO 8601 Date Time to filter statements FROM NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
toStatementDateTime
Date (date-time)
The UTC ISO 8601 Date Time to filter statements TO NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

Responses

Status: 200 - Statements Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

Transactions

getAccountsAccountIdStatementsStatementIdTransactions

Get Transactions


/accounts/{AccountId}/statements/{StatementId}/transactions

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/accounts/{AccountId}/statements/{StatementId}/transactions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        TransactionsApi apiInstance = new TransactionsApi();
        String statementId = statementId_example; // String | StatementId
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadTransaction6 result = apiInstance.getAccountsAccountIdStatementsStatementIdTransactions(statementId, accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getAccountsAccountIdStatementsStatementIdTransactions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransactionsApi;

public class TransactionsApiExample {

    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String statementId = statementId_example; // String | StatementId
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBReadTransaction6 result = apiInstance.getAccountsAccountIdStatementsStatementIdTransactions(statementId, accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getAccountsAccountIdStatementsStatementIdTransactions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *statementId = statementId_example; // StatementId
String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

TransactionsApi *apiInstance = [[TransactionsApi alloc] init];

// Get Transactions
[apiInstance getAccountsAccountIdStatementsStatementIdTransactionsWith:statementId
    accountId:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBReadTransaction6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.TransactionsApi()
var statementId = statementId_example; // {{String}} StatementId
var accountId = accountId_example; // {{String}} AccountId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdStatementsStatementIdTransactions(statementId, accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdStatementsStatementIdTransactionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransactionsApi();
            var statementId = statementId_example;  // String | StatementId
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Transactions
                OBReadTransaction6 result = apiInstance.getAccountsAccountIdStatementsStatementIdTransactions(statementId, accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionsApi.getAccountsAccountIdStatementsStatementIdTransactions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransactionsApi();
$statementId = statementId_example; // String | StatementId
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getAccountsAccountIdStatementsStatementIdTransactions($statementId, $accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getAccountsAccountIdStatementsStatementIdTransactions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransactionsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransactionsApi->new();
my $statementId = statementId_example; # String | StatementId
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getAccountsAccountIdStatementsStatementIdTransactions(statementId => $statementId, accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getAccountsAccountIdStatementsStatementIdTransactions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransactionsApi()
statementId = statementId_example # String | StatementId
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Transactions
    api_response = api_instance.get_accounts_account_id_statements_statement_id_transactions(statementId, accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getAccountsAccountIdStatementsStatementIdTransactions: %s\n" % e)

Parameters

Path parameters
Name Description
StatementId*
String
StatementId
Required
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Transactions Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

getAccountsAccountIdTransactions

Get Transactions


/accounts/{AccountId}/transactions

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/accounts/{AccountId}/transactions?fromBookingDateTime=&toBookingDateTime="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        TransactionsApi apiInstance = new TransactionsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        Date fromBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        Date toBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        try {
            OBReadTransaction6 result = apiInstance.getAccountsAccountIdTransactions(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent, fromBookingDateTime, toBookingDateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getAccountsAccountIdTransactions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransactionsApi;

public class TransactionsApiExample {

    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        Date fromBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        Date toBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        try {
            OBReadTransaction6 result = apiInstance.getAccountsAccountIdTransactions(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent, fromBookingDateTime, toBookingDateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getAccountsAccountIdTransactions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)
Date *fromBookingDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
Date *toBookingDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)

TransactionsApi *apiInstance = [[TransactionsApi alloc] init];

// Get Transactions
[apiInstance getAccountsAccountIdTransactionsWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
    fromBookingDateTime:fromBookingDateTime
    toBookingDateTime:toBookingDateTime
              completionHandler: ^(OBReadTransaction6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.TransactionsApi()
var accountId = accountId_example; // {{String}} AccountId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example, // {{String}} Indicates the user-agent that the PSU is using.
  'fromBookingDateTime': 2013-10-20T19:20:30+01:00, // {{Date}} The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
  'toBookingDateTime': 2013-10-20T19:20:30+01:00 // {{Date}} The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdTransactions(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdTransactionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransactionsApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 
            var fromBookingDateTime = 2013-10-20T19:20:30+01:00;  // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional) 
            var toBookingDateTime = 2013-10-20T19:20:30+01:00;  // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional) 

            try
            {
                // Get Transactions
                OBReadTransaction6 result = apiInstance.getAccountsAccountIdTransactions(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent, fromBookingDateTime, toBookingDateTime);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionsApi.getAccountsAccountIdTransactions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransactionsApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
$fromBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
$toBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

try {
    $result = $api_instance->getAccountsAccountIdTransactions($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent, $fromBookingDateTime, $toBookingDateTime);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getAccountsAccountIdTransactions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransactionsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransactionsApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.
my $fromBookingDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
my $toBookingDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

eval { 
    my $result = $api_instance->getAccountsAccountIdTransactions(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent, fromBookingDateTime => $fromBookingDateTime, toBookingDateTime => $toBookingDateTime);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getAccountsAccountIdTransactions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransactionsApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)
fromBookingDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
toBookingDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)

try: 
    # Get Transactions
    api_response = api_instance.get_accounts_account_id_transactions(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent, fromBookingDateTime=fromBookingDateTime, toBookingDateTime=toBookingDateTime)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getAccountsAccountIdTransactions: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Query parameters
Name Description
fromBookingDateTime
Date (date-time)
The UTC ISO 8601 Date Time to filter transactions FROM NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
toBookingDateTime
Date (date-time)
The UTC ISO 8601 Date Time to filter transactions TO NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

Responses

Status: 200 - Transactions Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String

getTransactions

Get Transactions


/transactions

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/aisp/v3.1/transactions?fromBookingDateTime=&toBookingDateTime="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        TransactionsApi apiInstance = new TransactionsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        Date fromBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        Date toBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        try {
            OBReadTransaction6 result = apiInstance.getTransactions(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent, fromBookingDateTime, toBookingDateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getTransactions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransactionsApi;

public class TransactionsApiExample {

    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        Date fromBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        Date toBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        try {
            OBReadTransaction6 result = apiInstance.getTransactions(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent, fromBookingDateTime, toBookingDateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getTransactions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)
Date *fromBookingDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
Date *toBookingDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)

TransactionsApi *apiInstance = [[TransactionsApi alloc] init];

// Get Transactions
[apiInstance getTransactionsWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
    fromBookingDateTime:fromBookingDateTime
    toBookingDateTime:toBookingDateTime
              completionHandler: ^(OBReadTransaction6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccountAndTransactionApi = require('account_and_transaction_api');
var defaultClient = AccountAndTransactionApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new AccountAndTransactionApi.TransactionsApi()
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example, // {{String}} Indicates the user-agent that the PSU is using.
  'fromBookingDateTime': 2013-10-20T19:20:30+01:00, // {{Date}} The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
  'toBookingDateTime': 2013-10-20T19:20:30+01:00 // {{Date}} The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTransactions(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTransactionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransactionsApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 
            var fromBookingDateTime = 2013-10-20T19:20:30+01:00;  // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional) 
            var toBookingDateTime = 2013-10-20T19:20:30+01:00;  // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional) 

            try
            {
                // Get Transactions
                OBReadTransaction6 result = apiInstance.getTransactions(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent, fromBookingDateTime, toBookingDateTime);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionsApi.getTransactions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransactionsApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
$fromBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
$toBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

try {
    $result = $api_instance->getTransactions($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent, $fromBookingDateTime, $toBookingDateTime);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getTransactions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransactionsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransactionsApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.
my $fromBookingDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
my $toBookingDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

eval { 
    my $result = $api_instance->getTransactions(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent, fromBookingDateTime => $fromBookingDateTime, toBookingDateTime => $toBookingDateTime);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getTransactions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransactionsApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)
fromBookingDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
toBookingDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)

try: 
    # Get Transactions
    api_response = api_instance.get_transactions(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent, fromBookingDateTime=fromBookingDateTime, toBookingDateTime=toBookingDateTime)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getTransactions: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Query parameters
Name Description
fromBookingDateTime
Date (date-time)
The UTC ISO 8601 Date Time to filter transactions FROM NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
toBookingDateTime
Date (date-time)
The UTC ISO 8601 Date Time to filter transactions TO NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

Responses

Status: 200 - Transactions Read

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String